Skip to main content

FlowPDFExport

Represents a step for exporting workflow data to a PDF file with various configuration options.

Properties

NameDescription
CaptionThe caption dictionary representing localized captions for the flow object.
ValueTypeDefines the type of the value being exported, such as text or numeric.
AuthorSpecifies the author metadata for the exported PDF document.
ResumeOnErrorIndicates whether the process should continue if an error occurs during execution.
TitleSpecifies the title metadata for the exported PDF document.
KeyA unique identifier for the workflow step.
ExportOptionsProvides detailed configuration options for exporting the file, such as format and save options.
NameName for the workflow step.
ValueHolds the value that will be exported as part of the workflow step.
ErrorDescriptionObjectNameSpecifies the object name used to store error descriptions.
SubjectSpecifies the subject metadata for the exported PDF document.
WorkflowCodeInstanceThe workflow code instance associated with the flow object.
ErrorOptionsDefines error-related options for the API step.
CachedDMObjectsThe cached document management objects related to the flow object.
ExternalParametersContains external parameters that can be passed into the export operation.
FileIdHolds the ID of the file generated by the export process.
TypeCodeThe type code associated with the flow object.
ValueSourceTypeDetermines the source type of the value, specifying where it originates.
SelectedLanguagesLists the languages selected for multilingual content in the exported file.

Constructors

NameDescription
FlowPDFExport(name, workflowData, workflowCodeInstance)Initializes a new instance of the FlowPDFExport step with the specified name, workflow data, and optional workflow code instance.
FlowPDFExport(name, workflowData, workflowCodeInstance)Constructor for the FlowPDFExport class. Initializes a new instance of the FlowPDFExport class.
FlowPDFExport(name,workflowData,workflowCodeInstance)Initializes a new instance of the FlowPDFExport class with a name, workflow data, and workflow code instance.

Methods

NameDescription
Export()Exports the workflow data to a PDF file using the specified export options.
Initialize()Initializes the export step with default or custom configurations.
ToLiquid()Converts the current step's key properties into a format compatible with the Liquid templating engine.

Events

NameDescription
OnAfterExecution(sender, args)Occurs after the execution of the workflow step.
Execute(sender, args)Occurs during the execution of the FlowPDFExport step, triggering whenever an execution-related event occurs.
OnBeforeExecution(sender, args)Occurs before the execution of the workflow step.